Planno - User Guide

By: Team W14-B4 Since: Sep 2017 Licence: NUS

Planno - User Guide

1. About

Sometimes do you feel that you have too many contacts and cannot manage them clearly? Or sometimes you have too many events and cannot remember all the participants involved in those events? Do not worry! Planno can help you to solve these problems!

Planno is an assistant that helps you to manage your contacts and events. It can tell you who the participants are of a particular event. Moreover, it can tell you your contacts join in which event.

Planno is a command-line based application, and it has very few click buttons. Hence, you only need to remember some very simple command format to make full use of Planno’s function.

This user guide will give you a step by step instruction on how you can start up and use Planno, and a brief introduction of the features you can use in Planno.

2. Getting Started

Before we start our journey on Planno, here are some simple steps for you to launch this application:

Ensure you have Java version 1.8.0_60 or later installed in your Computer.

ℹ️
Having any Java 8 version is not enough.
This app will not work with earlier versions of Java 8.
Download the latest planno.jar here.
Copy the file to a clean folder that you want to use as the home folder for Planno.
Double-click the file to start the app. The GUI should appear in a few seconds, as shown in the figure below. Note that you will see some initial data if it is the first time to use.

Figure 2: GUI
Type the command in the command box and press Enter to execute it.
e.g. If you type help and press Enter, Planno will open the help window for you.
Try some sample commands like these:
- list : lists all contacts
- addn/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 : adds a contact named John Doe to the Person List.
- delete3 : deletes the 3rd contact shown in the current list
- exit : exits the app
  
  ℹ️
  For the details of each command, please refer to Features section.
Congratulations! Now you have successfully launched Planno, and you can start trying this application. If you have any trouble in launching Planno, please refer to FAQ and solve your problems.

3. Features

As mentioned in the ABOUT, Planno supports command lines to perform its features. In this section, you will know what command format Planno supports, and what features Planno provides.

3.1. General

Command Format

Words in UPPER_CASE are the parameters to be supplied by the user e.g. in add n/NAME, NAME is a parameter which can be used as add n/John Doe.
Items in square brackets are optional e.g n/NAME [t/TAG] can be used as n/John Doe t/friend or as n/John Doe.
Items with … after them can be used multiple times including zero times e.g. [t/TAG]… can be used as (i.e. 0 times), t/friend, t/friend t/family etc.
Parameters can be in any order e.g. if the command specifies n/NAME p/PHONE_NUMBER, p/PHONE_NUMBER n/NAME is also acceptable.
Command key wards are case sensitive. e.g. only help means help command, while HELP, HElp, hElP are not.

How does Planno Look Like

Planno consists of the following 4 components:

Command Box: it is a single line below the FILE button where you should enter your command.
Result Display: it is the black box below command box where the feedback of you command will be displayed. The feedback is a message that indicates whether your command has been successfully executed.
Person List: it is a red panel that contains a list of person cards (see Figure 3.1.1). Each person card displays a person’s name, tags, phone number, email, address and birthday.

Figure 3.1.1: person list panel

Event List: it is a blue panel that contains a list of event cards (see Figure 3.1.2). Each event card displays an event’s name, description and date. Also, a number with an arrow sits on the right side of the event card. If the event date is before today, the number will be appended with an up arrow, indicating how many days have passed since the event date. Otherwise, if the event date is after today, the number will be appended with a down arrow, indicating how many days are left before the event.

Figure 3.1.2: event list panel

Information Board: it is a green panel displays the result of some commands. For example, the results of displayEmails command will display a list of emails in the information board.

Now that you are familiar with what each part of Planno does, you can now continue to take a look at the commands Planno supports.

3.2. Adding

An add command can add a new person to the Person List, or a new event to the Event List

3.2.1. Adding a person : `add`

Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…

A person can have any number of tags (including 0)

Examples:

add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01
add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal

3.2.2. Adding an event : `addE`

Format: addE en/EVENT_NAME ed/EVENT_DESCRIPTION et/EVENT_TIME

You need to type EVENT_TIME as a date format DD/MM/YYYY (Use "/" insetead of "-")
If the day or month have only 1 digit, please append '0' before it (e.g. For 2017 April 2nd, please type 02/04/2017 instead of 2/4/2017)
The EVENT_TIME must be after 01/01/1900
Every event will have a number indicating the of days till or since the event date.
- If the event date has passed, an up arrow will be appended to the numbr to indicate how many days have passed since the evnet date.
- If the event date is not yet reached, a down arrow will be appended to the number to indicate the number of days till the event.

If the evnet to be add in an addE command is out-dated (ie. event date has passed), an alert dialog will pop up. This dialog (shown in Figure 3.1.1) will ask you whether you want to add this out-dated event into Planno.
- If you want to add this event, click OK.
- If you do not want to add this event anymore, click CANCEL.

Figure 3.2.1: alert dialog for adding out-dated events

Example:

addE en/CS2101 meeting ed/Discuss how to conduct software demo. et/30/10/2017
addE en/Submit assignment ed/Submit programming assignment 2 et/23/10/2017

3.3. Listing

3.3.1. Listing all persons : `list`

This command shows a list of all persons in the Person List.
Format & Example: list

3.3.2. Listing all events : `listE`

This command shows a list of all events in the Event List.
Format & Example: listE

You will see the following after typing 2 above example list command:

Figure 3.3: list command result

3.4. Sorting

An sort command can modify the order of the person list or event list.

3.4.1. Sorting person list : `sort`

You can use it to view a list of sorted persons in the address book according to the alphabetical order of their names.
Format & Example: sort

The sorting of person names is case-insensitive.

3.4.2. Sorting event list : `sortE`

You can use it to view a list of sorted events in the event list according to the event time. Format & Example: sortE

Events are sorting in the ascending order.

You will see the following after typing sort command and sortE command:

Figure 3.4: sort command result

3.5. Editing

An edit command can modify the information of an existing person or event.

3.5.1. Editing a person : `edit`

Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…

This command edits the person at the specified INDEX. The index refers to the index number shown in the last person listing. The index must be a positive integer 1, 2, 3, …
At least one of the optional fields must be provided.
Existing values will be updated to the input values.
When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
You can remove all the person’s tags by typing t/ without specifying any tags after it.

Examples:

edit 1 p/91234567 e/johndoe@example.com
Edits the phone number and email address of the 1st person to be 91234567 and johndoe@example.com respectively.
edit 2 n/Betsy Crower t/
Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.

3.5.2. Editing an event : `editE`

You can use it to edits an existing event in the event list.
Format: editE INDEX [en/NAME] [ed/DESCRIPTION] [et/TIME]

This command edits the event at the specified INDEX. The index refers to the index number shown in the last event listing. The index must be a positive integer 1, 2, 3, …
At least one of the optional fields must be provided.
Existing values will be updated to the input values.
You need to type TIME as a date format DD/MM/YYYY.

Examples:

editE 1 en/CS2103 project meeting et/03/11/2017
Edits the event name and event time of 1st event to be CS2103 project meeting and /03/11/2017 respectively.
editE 2 ed/Submit handwritten assignment.
Edits the event description of 2nd event to be Submit handwritten assignment

3.6. Finding

3.6.1. Locating persons by name: `find`

Finds persons whose names contain any of the given keywords.
Finds persons who have any of the given tags.
Format: find KEYWORD [MORE_KEYWORDS]

The search is case insensitive. e.g hans will match Hans
The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans
The name and tag names searched.
Tags should be indicated by prefix t/
Only full words will be matched e.g. Han will not match Hans
Persons matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang

Examples:

find John
Returns john and John Doe
find Betsy Tim John
Returns any person having names Betsy, Tim, or John
find t/friends Returns any person having tag friends
find t/colleagues John Returns any person having name John or having tag colleagues

If you enter find t/colleagues John in your command box, you will see your person list like the following figure 3.6.1, and the result display like figure 3.6.2.

Figure 3.6.1: person list after entering command “find t/colleagues John”

Figure 3.6.2: result display after entering command “find t/colleagues John”

3.6.2. Locating events by name: `findE`

Finds events whose names contain any of the given keywords.
Format: findE KEYWORD [MORE_KEYWORDS]

The search is case insensitive. e.g meeting will match Meeting
The order of the keywords does not matter. e.g. First Meeting will match Meeting First
The name searched.
Only full words will be matched e.g. Meetin will not match Meeting
Events matching at least one keyword will be returned (i.e. OR search). e.g. First Meeting will return Second Meeting, First Event

Examples:

find meeting
Returns Meeting and meeting
find Sports Meeting
Returns any event having names Sports`or `Meeting

3.7. Deleting

A delete command can delete a person from Person List, or delete an event from Event List.

3.7.1. Deleting a person : `delete`

Format: delete INDEX

This command deletes the person at the specified INDEX from Person List.
The index refers to the index number shown in the most recent listing, and it must be a positive integer 1, 2, 3, …

Examples:

list
delete 2
Deletes the 2nd person in the address book.
find Betsy
delete 1
Deletes the 1st person in the results of the find command.

3.7.2. Deleting an event : `deleteE`

Format: deleteE INDEX

This command deletes the event at the specified INDEX from Event List.
The index refers to the index number shown in the most recent listing, and it must be a positive integer 1, 2, 3, …

Example:

listE
deleteE 2
Deletes the 2nd event in the event list.

3.8. Selecting a person : `select`

Selects the person identified by the index number used in the last person listing.
Format: select INDEX

Selects the person and loads the Google search page the person at the specified INDEX.
The index refers to the index number shown in the most recent listing.
The index must be a positive integer 1, 2, 3, …
The browser will be displayed when the command is used.

Examples:

list
select 2
Selects the 2nd person in the Planno.
find Betsy
select 1
Selects the 1st person in the results of the find command.

You will see the following after typing select 1:

Figure 3.8: select command result

3.9. Connecting a person to an event : `join`

Format : join p/INDEX_P e/INDEX_E

You can use it to indicate that a person is involved in an event.

The person at position INDEX_P will be involved in the event at position INDEX_E .
The index must be a positive integer 1, 2, 3, …
Make sure you type the prefixes p/ and e/ to distinguish person index and event index.

Example:

list
listE
join p/2 e/1
The 2nd person in the address book will be involved in the 1st event in the event list.

3.10. Disconnecting a person to an event : `disjoin`

Format : disjoin p/INDEX_P e/INDEX_E

You can use it to indicate that a person does not participate an event any more.

The person at position INDEX_P will be involved in the event at position INDEX_E .
The index must be a positive integer 1, 2, 3, …
Make sure you type the prefixes p/ and e/ to distinguish person index and event index.
This person must be already involved in this event.

Example:
Assuming that you have typed join p/2 e/1 before this example.

list
listE
disjoin p/2 e/1
The 2nd person in the address book will not be involved in the 1st event in the event list any more.

3.11. Showing all participants of an event : `showP`

Format: showP EVENT_INDEX

The command shows you all persons who join the event at the specified EVENT_INDEX.

Shows all persons who join the event at the specified EVENT_INDEX.
The index refers to the index number shown in the most recent event listing.
The index must be a positive integer 1, 2, 3, ….

Example:

join p/2 e/1 listE
showP 1
Shows all participants who are involved in the 1st event of event list.

Figure 3.11 shows the result of the example above:

Figure 3.11: show persons result

3.12. Selecting and showing all events which a person joins : `selectE`

Format: selectE PERSON_INDEX

The command shows you all events which the person at the specified PERSON_INDEX joins

Selects and shows all events which the person at the specified PERSON_INDEXS joins.
The index/s refers to the index number/s shown in the most recent person listing.
The index/s must be a positive integer 1, 2, 3, ….

Examples:
Assuming that you have typed join p/2 e/1 before this example.

list
selectE 2
Shows all events which the 2nd person in Planno joins.
find Betsy
selectE 1
Shows all events which the 1st person in the results of the find command joins.

You will see the following after typing list and selectE 2:

Figure 3.12: select events result

3.13. Displaying particulars of every person in an event : `display`

You can use it to view a certain particular of every person in an event.
Format: display EVENT_INDEX PARTICULAR

The PARTICULAR must be either email, phone, or address.
Shows emails of every person in the event specified by EVENT_INDEX.
The index refers to the index number shown in the most recent event listing.
The index must be a positive integer 1, 2, 3, ….

Examples:
Assuming that you have typed join p/1 e/1 and join p/2 e/1 before this example.

list
display 1 email
Shows the email of every person who is in the first event in the person list.

The following particulars will be displayed in the Information Board after you type list and display 1 email:

Figure 3.13: display result

3.14. Attaching a portrait to a person: `portrait`

You can use this command to attach a portrait to a person so that you can identify him easily.

ℹ️	`portrait` command is the only way to change a person’s portrait.

If a person has no portrait (i.e, only the default portrait), or the app cannot load the picture by the path that you provide, the following picture will be displayed:

Figure 3.14.1 default portrait

Format: portrait PERSON_INDEX p/IMAGE_FILE_PATH

The image file path should be in this format:
HARD_DISK_NAME:/[FOLDER_NAME]/FILE_NAME
You can leave the IMAGE_FILE_PATH as empty to remove the person’s portrait.
The application only supports .jpg and .png images.

Example:

Assume that you have a picture sample picture.png. It is in C:/Users/My Profile/Images, and looks like this:

Figure 3.14.2 the sample.png

Then, you can type this command to attach it to the first person in Person List:

portrait 1 p/C:/Users/My Profile/Images/sample picture.png

The first person will change like this (Figure 3.14.3):

Figure 3.14.3 portrait result

You can use either '\' or '/' to separate two subfolders.
If the app cannot load the picture by the path that you provide, the Result Display will still tell that you attach a portrait to that person, but the image in person card will change to default image.

3.15. Toggling between details and browser: `toggle`

You can use this command to toggle between displaying the information board and events list, or a browser.

Format & Example: toggle

Toggling when the information board and events list are displayed will have a browser replace them.
Toggling when the browser is displayed will have the information board and events list replace them.
After toggling to the browser, it will not be visible unless a select command has been entered once before.

You will see the following after typing the toggle command when the information board and events list are displayed but a select command has not been entered:

Figure 3.15.1 toggle result when browser is displayed

You will see the following after typing the toggle command when the browser is displayed:

Figure 3.15.2 toggle result when information board and events list are displayed

You will see the following after typing the toggle command when the information board and events list are displayed and a select command:

Figure 3.15.3 toggle result when information board and events list are displayed and a select command is entered before

3.16. Listing entered commands : `history`

Format & Example: history

Lists all the commands that you have entered in reverse chronological order. Also, if you press the ↑ and ↓ arrows, the command box can display the previous and next input respectively. You will see the following in the Result Display after typing history command (note that you can use the scroll bar on the right to scroll down and see more history commands).:

Figure 3.16: history result

3.17. Undoing previous command : `undo`

Restores the address book or event list to the state before the previous undoable command was executed.
Format: undo

Undoable commands: those commands that modify the content in address book or event list (add, delete, edit, clear, join, disjoin, and portrait).

Examples:

delete 1
list
undo (reverses the delete 1 command)
select 1
list
undo
The undo command fails as there are no undoable commands executed previously.
delete 1
clear
undo (reverses the clear command)
undo (reverses the delete 1 command)

3.18. Redoing the previously undone command : `redo`

Reverses the most recent undo command.
Format: redo

Examples:

delete 1
undo (reverses the delete 1 command)
redo (reapplies the delete 1 command)
delete 1
redo
The redo command fails as there are no undo commands executed previously.
delete 1
clear
undo (reverses the clear command)
undo (reverses the delete 1 command)
redo (reapplies the delete 1 command)
redo (reapplies the clear command)

3.19. Clearing all entries : `clear`

Clears all entries from the address book and the event list.
Format & Example: clear

You will clear all entries from the Person List and the Event List. The Person List, Information Board, and the Event List will be like the following figure 3.19:

Figure 3.19: clear result

3.20. Viewing help : `help`

Format & Example: help
A help window which is same as this user guide will pop up.

3.21. Exiting the program : `exit`

Exits the program.
Format & Example: exit

3.22. Saving the data

Address book data are saved in the hard disk automatically after any command that changes the data.
There is no need to save manually.

4. Features coming in V2.0

The following features are coming for version 2.0

Users can connect this app with several social media platforms, and import data from them.
Users can send messages through this app.
Users can be alarmed when an event is going to take place.
Users can design their own GUI appearances (e.g colour, font).

5. Command Summary

Adding an event addE en/EVENT_NAME ed/EVENT_DESCRIPTION et/EVENTTIME
e.g. adde en/Project Meeting ed/Project meeting with CS2103 Team Members et/20/10/2017
Adding a person add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…
e.g. add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague
Attach a portrait to a person : portrait PERSON_INDEX p/IMAGE_FILE_PATH e.g. portrait 1 p/C:/Users/My Profile/Images/sample picture.png
Clear : clear
Deleting an event : deleteE INDEX
e.g. deleteE 5
Deleting a person : delete INDEX
e.g. delete 3
Disjoining an event : disjoin p/PERSON_INDEX e/EVENT_INDEX
e.g. disjoin p/4 e/6
Editing an event : editE INDEX [en/NAME] [ed/DESCRIPTION] [et/TIME]
e.g. edit 1 en/Lunch ed/Lunch with Albert at Bishan
Editing a person : edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…
e.g. edit 2 n/James Lee e/jameslee@example.com
Find : find KEYWORD [MORE_KEYWORDS]
e.g. find James Jake e.g. find t/friends e.g. find t/neighbors alex
Help : help
History : history
Joining an event join p/PERSON_INDEX e/EVENT_INDEX
e.g. join p/3 e/1
Listing every person : list
Listing every event : listE
Redo : redo
Selecting a person : select INDEX
e.g. select 4
Selecting and showing every event a person has joined : selectE p/INDEX
e.g. selectE p/1
Showing every participant in an event : showP EVENT_INDEX
e.g.showP 2
Sort : sort
Undo : undo

6. FAQ

Q: Do I need to install anything else other than Java 1.8.0_60?
A: No. Planno only needs Java 1.8.0_60 or any later versions to work.

Q: How do i run/open Planno with the jar file?
A: Double click the jar file to run Planno.

Q: Can I run Planno with a older version of Java?
A: No. You will not be able to run Planno.

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Address Book folder.

Files

UserGuide.adoc

Latest commit

History

UserGuide.adoc

File metadata and controls

Planno - User Guide

1. About

2. Getting Started

3. Features

3.1. General

3.2. Adding

3.2.1. Adding a person : add

3.2.2. Adding an event : addE

3.3. Listing

3.3.1. Listing all persons : list

3.3.2. Listing all events : listE

3.4. Sorting

3.4.1. Sorting person list : sort

3.4.2. Sorting event list : sortE

3.5. Editing

3.5.1. Editing a person : edit

3.5.2. Editing an event : editE

3.6. Finding

3.6.1. Locating persons by name: find

3.6.2. Locating events by name: findE

3.7. Deleting

3.7.1. Deleting a person : delete

3.7.2. Deleting an event : deleteE

3.8. Selecting a person : select

3.9. Connecting a person to an event : join

3.10. Disconnecting a person to an event : disjoin

3.11. Showing all participants of an event : showP

3.12. Selecting and showing all events which a person joins : selectE

3.13. Displaying particulars of every person in an event : display

3.14. Attaching a portrait to a person: portrait

3.15. Toggling between details and browser: toggle

3.16. Listing entered commands : history

3.17. Undoing previous command : undo

3.18. Redoing the previously undone command : redo

3.19. Clearing all entries : clear

3.20. Viewing help : help

3.21. Exiting the program : exit

3.22. Saving the data

4. Features coming in V2.0

The following features are coming for version 2.0

5. Command Summary

6. FAQ

3.2.1. Adding a person : `add`

3.2.2. Adding an event : `addE`

3.3.1. Listing all persons : `list`

3.3.2. Listing all events : `listE`

3.4.1. Sorting person list : `sort`

3.4.2. Sorting event list : `sortE`

3.5.1. Editing a person : `edit`

3.5.2. Editing an event : `editE`

3.6.1. Locating persons by name: `find`

3.6.2. Locating events by name: `findE`

3.7.1. Deleting a person : `delete`

3.7.2. Deleting an event : `deleteE`

3.8. Selecting a person : `select`

3.9. Connecting a person to an event : `join`

3.10. Disconnecting a person to an event : `disjoin`

3.11. Showing all participants of an event : `showP`

3.12. Selecting and showing all events which a person joins : `selectE`

3.13. Displaying particulars of every person in an event : `display`

3.14. Attaching a portrait to a person: `portrait`

3.15. Toggling between details and browser: `toggle`

3.16. Listing entered commands : `history`

3.17. Undoing previous command : `undo`

3.18. Redoing the previously undone command : `redo`

3.19. Clearing all entries : `clear`

3.20. Viewing help : `help`

3.21. Exiting the program : `exit`